home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbs_soft / master19.zip / MASTER.DOC < prev    next >
Text File  |  1993-03-29  |  15KB  |  332 lines
  1.  
  2.  
  3.  
  4.  
  5. ───────────────────────────────────────────────────────────────────────────────
  6.           ListMaster v1.9  |  Garrett Whitney  |  Gamma Software Design
  7. ───────────────────────────────────────────────────────────────────────────────
  8.  
  9.                            Master File List Generator
  10.                                   Version 1.9
  11.                            Written By Garrett Whitney
  12.                            Gamma Programming Northwest
  13.                                    ShareWare
  14.  
  15.  
  16.                      Written and Compiled in QuickBasic 4.5
  17.                         Compiled on Sunday March 16, 1993
  18.                              For use with most any BBS
  19.  
  20.  
  21.  
  22.  
  23.  
  24.   Table of Content's ............................................... Page
  25.  
  26.   Shareware & Registration Information ................................ 1
  27.   Version Updates ..................................................... 2
  28.   The Configuration File & Setup ...................................... 3
  29.   ListMaster Command Line Execution ................................... 4
  30.   Up & Coming versions of ListMaster .................................. 5
  31.   For Your Information - Notes ........................................ 6
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.         Page 1 - Shareware & Registration Information
  39.  
  40.  
  41.         ListMaster is a Shareware Program which means that you may use this
  42.  program free for a limited time, then you must register it. You may use this
  43.  program free for 30 days, after your 30 day trial period, you must register
  44.  it. Registration for ListMaster is Free however, just fill out Register.Txt
  45.  and mail it to me. Since this is Distributed as Shareware, I can not
  46.  Garauntee that it is free of harm. Therefore i take no responsibility for any
  47.  damages which this program may cause. (Pretty ir-responsible of me huh?
  48.  I bet you heard your parent's say that to you a few times!) I am not going
  49.  to say that this program is error free either. If you find an error, please
  50.  let me know about it so i can fix it.
  51.  
  52.         Registering ListMaster is easy and FREE! Just fill out Register.Txt
  53.  and mail it to me. What this registration will do is tell me who is
  54.  interested in my program and wether I should continue to distribute future
  55.  version's or not. I really enjoy programming and I hope you enjoy what I
  56.  write. Thank You for using ListMaster.
  57.  
  58.  
  59.         Page 2 - Version Update's
  60.  
  61.  
  62.                            ListMaster v1.9 Updates
  63.  
  64.         * Added a percentage screen update. It now show's you the percentage
  65.           of file area's completed.
  66.  
  67.         * Color's have been changed slightly.
  68.  
  69.         * Fixed a bug - when reading PcBoard color's the program would only
  70.           take out the code if it was in the file description. It is now
  71.           removed from header's as well.
  72.  
  73.         * Improved the error handling routine's in the program. You should
  74.           now get a more accurate response to an error. Instead of getting
  75.           the general error comment.
  76.  
  77.         * An error log is now created. When an error has occured, ListMaster
  78.           will note what error it was and when it occured in the Master.Log
  79.           file which is created even if an error did not occur.
  80.  
  81.  
  82.  
  83.         Page 3 - The Configuration File
  84.  
  85.  
  86.                            The Configuration File
  87.  
  88.    Line 1 ->  Gamma Programming Northwest Bulletin Board System
  89.    Line 2 ->  Garrett Whitney
  90.    Line 3 ->  Gamma Programming BBS - OPEN 10pm - 7am ONLY - (206) 830-0314
  91.    Line 4 ->  000000000
  92.    Line 5 ->  PCBLIST
  93.    Line 6 ->  196
  94.    Line 7 ->  skip
  95.    Line 8 ->  D:\FILES\01\GPNFILE.LST
  96.    Line 9 ->  PcBoard
  97.    Line 10 -> none
  98.    Line 11 -> none
  99.    Line 12 -> 1
  100.    Line 13 -> Gamma Programming Information
  101.    Line 14 -> D:\FILES\01\
  102.  
  103.         This is just an example of a configuration file that is used by
  104.  ListMaster. This is the Configuration that can be found in MASTER.CFG which
  105.  should be located in the Archive. With all of the feature's being added each
  106.  update, the CFG is getting pretty complicated. I will try and explain wich
  107.  line's are new addition's.
  108.  
  109.         Line 1 is just the Name of your BBS. This will be placed in the output
  110.  file in the header as well as on the screen while ListMaster is running.
  111.  
  112.         Line 2 is the name of the Sysop which will be placed in the header of
  113.  the output file.
  114.  
  115.         Line 3 is a one line description that will be placed in the header of
  116.  the output file. I use this for the hour's of my BBS. You can use it for
  117.  anything: Description, Membership Price's, Phone Number, etc...
  118.  
  119.         Line 4 is where you put your Registration Code when you get it.
  120.  It does not matter what you put here but it is probably best to leave it as
  121.  it is. The Registration code removes the UNREGISTERED Evaluation Copy at the
  122.  end of execution and the 10 second delay.
  123.  
  124.         Line 5 is the name of the File List that ListMaster will be reading
  125.  from to get the file's to place in the output file. For PcBoard, you are
  126.  allowed to use different List Filename's. If you do this, you might be able
  127.  to get around this feature by leaving this line blank and adding the
  128.  List Filename onto the Path. Example for Line 12 put D:\FILES\01\PCBLIST
  129.  This might work, i am unsure but will include this problem in the next
  130.  release if it doesn't.
  131.  
  132.         Line 6 is an option that will allow you to customize your output file.
  133.  You may place a number here from 1 to 255. This number specifies a character
  134.  in the ASCii character chart. A total of fifty of these characters will be
  135.  placed under the File Area title when the master list is made. Look for a
  136.  program called ASCii.exe for a list of ASCii character's or just play with
  137.  it.
  138.                  196 = Single Line (─)   205 = double Line (═)
  139.  
  140.         Line 7 is the Archive command which is new to this version. You may
  141.  specify any acceptable DOS command on this line. You may place a command
  142.  or a batch file to run. I do NOT recommend specifying to run another
  143.  Executable program here unless it is something small like an archiveing tool.
  144.  An example would be:
  145.         PkZip D:\Files\01\GPNFILE D:\Files\01\GPNFILE.LST
  146.  This would create the Zip File GPNFILE.ZIP and include the Master List
  147.  GPNFILE.LST. For more information on using PkZip, consult your manual.
  148.  If one command line will not do what you want then specifying a Batch file
  149.  would be in your best interest. Make sure you either specify the path to the
  150.  batch to execute or the batch file reside's in the same directory as
  151.  Master.Exe. Example:
  152.         \Batch\LMZIP.BAT   <- This would run LMZIP.BAT in the directory called
  153.  Batch on the current drive.
  154.  Any archiving tool may be used on this line since basically, it is just
  155.  executing this line on the DOS command prompt. If you do not want to use this
  156.  option then just put the word SKIP on this line. SKIP will tell ListMaster
  157.  to skip this option.
  158.  
  159.         Line 8  is the path + filename you want ListMaster to generate as an
  160.  output file. This is the Master File Listing that is the outcome of
  161.  ListMaster.
  162.  
  163.         Line 9 the Type of List you have. It can be one of three thing's.
  164.  
  165.         ASCii -> This is for plain ASCii Text List's. These will basically
  166.         just be copied into the Master Listing.
  167.  
  168.         Spitfire -> This should be used if you use the  code's in your
  169.         File List's. I hate how Spitfire uses that to seperate line's but
  170.         you have to live with it. You should use this feature if you have
  171.         's in your File List's. It is a little slower this way but it
  172.         look's nicer than with the little  faces in it.
  173.  
  174.         PcBoard -> This option will do the same as ASCii but will take out
  175.         the little pipe character's (|) before putting it into the Master
  176.         List. This will also remove anything after a % sign.
  177.         So if you use the WGM-DMS program that create's a header for your file
  178.         area's and you have it configured to keep the header in another
  179.         directory then WGM-DMS will put a %(path) line at the beginning of
  180.         your file list. The PCBOARD option will read the % sign and ignore
  181.         the line starting from the % sign to the end of the line.
  182.  
  183.         Line 10 is a File that you may include at the beginning of your Master
  184.  File listing. After the Header is placed in the output file, ListMaster will
  185.  read in this file and place it exactly into the output file then begin listing
  186.  the file list's. An opening screen or short new's file would be good for this
  187.  option. If you do not want to use this option then put the word NONE on this
  188.  line.
  189.  
  190.         Line 11 is a File that you may include at the end of your File
  191.  Listing's. After the File Listing's are done, ListMaster will check for this
  192.  file. If there is a file specified here, ListMaster will copy it line for line
  193.  to the output file. This way you can put an ANSI file or something in here but
  194.  it is adviseable that it just be a plain ASCii text file. I use it for a news
  195.  file or something similar. Use your imagination. If you do not want a file
  196.  to be placed at the end of the List, then just put the word NONE on this line.
  197.  
  198.         Line 12 is the Total number of File Area's that you want to be listed
  199.  in the Output File. You must not specify more than you actually list below.
  200.  You may have a number that is less than the total listed though.
  201.  An error will occur if you have a larger total number than the total you
  202.  hae listed below.
  203.  
  204.         Line 13 and every odd numbered line to the end of the file are similar
  205.  that they are all File Area Topic's. Every odd numbered line from Line 11
  206.  should be the File Area Topic. This will be underlined and the file's listed
  207.  below it.
  208.  
  209.         Line 14 and every even numbered line to the end of the file should
  210.  be the Path to the List File listed in Line 5. You must leave a slash at the
  211.  end of the path. (Example: D:\Files\01\)
  212.         If you run a PcBoard BBS and have different File List Name like
  213.  PCBLIST1 and PCBLIST2 then you might be able to leave Line 5 blank and
  214.  put the List Filename after the slash on these line's. If you do it to one
  215.  then you must do it to all of them though.
  216.  
  217.  
  218.         Page 4 - Execution
  219.  
  220.  
  221.                             ListMaster Execution
  222.  
  223.         Now that you have the Configuration File setup, the rest is easy.
  224.  
  225.         If your configuration file is NOT name MASTER.CFG then you MUST
  226.  specify the name of the CFG file on the command line. Example:
  227.  
  228.         MASTER MYFILE.CFG
  229.  
  230.         This will run ListMaster and use MYFILE.CFG for the Configuration
  231.  parameter's. However if you are using MASTER.CFG for the configuration
  232.  file name then all you have to do is execute MASTER.EXE and it will
  233.  automatically look for MASTER.CFG. The rest is automated.
  234.  
  235.  
  236.         Page 5 - Up & Coming version's of ListMaster
  237.  
  238.  
  239.         I am in the process of doing a total re-write of ListMaster.
  240.  I am renaming it to ListMaster Professional and starting the version back
  241.  to version 1.0 or whatever the first release may be. It is still
  242.  ListMaster but will be way more advanced. Here is a peek at some of the
  243.  feature's I am working on:
  244.  
  245.         * The error log is turned into a Usage log. Error's and run time's
  246.           are logged.
  247.  
  248.         * ANSI & ASCii bulletin's are created if desired.
  249.  
  250.         * A compressed/color file listing is created if desired.
  251.           This is a major feature. This listing will contain color code's
  252.           such as PcBoard's. The list will also be compressed internally
  253.           and should have greater compression than PkZip can do.
  254.           The user can download the file and view it.
  255.  
  256.         * A viewer will be included for user's to download seperately.
  257.           The viewer will uncompress the compressed/color listing and view
  258.           it with color. It will be somewhat like reading your mail off-line.
  259.           I don't know how well this feature's gonna go over with user's
  260.           but it is one of the major feature's in LMP (ListMaster Pro).
  261.  
  262.         * A configuration editor will be included. Mouse supported.
  263.           Will automatically read PcBoard's CNAMES.@@@ for a list of
  264.           conference's so all you have to do is click the mouse button on
  265.           the name. This was a requested addition and is a major feature of
  266.           LMP. I am working on this one currently and it is turning out nicely.
  267.           No more hassle with the CFG file. It is now automatically created or
  268.           you can edit your previous CFG file. Icon's are on the main menu
  269.           for mouse support or keyboard.
  270.  
  271.         There is much more but I don't want to spoil it. I will probably add
  272.  more before it is released anyways. Contact me for release date's or questions
  273.  on anything.
  274.  
  275.  
  276.  
  277.         Page 6 - For Your Information
  278.  
  279.  
  280.         ListMaster is pure QuickBasic Source Code. I used no libraries to
  281.  write it. If there is something special you would like ListMaster to do then
  282.  notify me and I can make a personalized copy for you or add it to the next
  283.  update.
  284.         If you have a copy of BRUN45.EXE and are running short on disk space
  285.  then I can Compile you a copy requiring BRUN45.EXE. This copy is about 50K
  286.  where the copy requiring BRUN45.EXE is only about 9K. Plus only 5K with
  287.  PkLite.
  288.         I am always happy to hear comment's so please give your opinion.
  289.  
  290.         I can be contacted on the following Bulletin Board's:
  291.  
  292.         Gamma BBS 10pm - 7am ONLY (206) 830-0314
  293.         Sports Complex (206) 692-2388
  294.         Vox Populi BBS (206) 895-1376
  295.         Darkstar's BBS (206) 871-3965
  296.         PC Toyshop BBS (503) 686-5055
  297.  
  298.         The latest version of ListMaster can also be found on these Board's.
  299.  
  300.         I can also be contacted through the following Net-Mail conferences:
  301.  
  302.         RIME Network:
  303.  
  304.         Shareware       Programming     QuickBasic
  305.  
  306.         MetroLink Network:
  307.  
  308.         Shareware
  309.  
  310.         Your best chance of getting ahold of me is through Rime. You might
  311.         also be able to contact me through Fido or possibly Intelec
  312.         conferences. You will not get a swift reply through those conferences
  313.         though. Address all mail to Garrett Whitney.
  314.  
  315.  
  316.         Remember that ListMaster is Shareware but Registration is Free.
  317.         Please Register it by filling out Register.Txt and sending it to me.
  318.  
  319.  
  320.         QuickBasic is a Registered Trademark of Microsoft Inc.
  321.         PkLite is a Registered Trademark of PkWare & Phil Katz
  322.         PkZip is a Registeres Trademark of PkWare & Phil Katz
  323.         WGM-DMS is a Registered Trademark of Wayne G. Maas
  324.         Spitfire is a Registered Trademark of Buffaloe Creek Softare
  325.         PcBoard is a Registered Trademark of Clark Development Company
  326.  
  327.  
  328. ───────────────────────────────────────────────────────────────────────────────
  329.           ListMaster v1.9  |  Garrett Whitney  |  Gamma Software Design
  330. ───────────────────────────────────────────────────────────────────────────────
  331.  
  332.